Create a new user (OpenID)
{ createUserOpenId }
Adds a new user in the system for OpenID Authentication.
Method
/API3/access/createUserOpenId
Input Parameters
Name
createUserOpenId
Object Type
Description
The object used to create a new user when OpenID authentication is used.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Notes
First create the User object with all its settings. Use other methods for alternative authentication providers
Code Snippets
JavaScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/access/createUserOpenId" \
-d '{
"lastName" : "lastName",
"adminType" : "None",
"proxyAccount" : "proxyAccount",
"clientLicenseType" : "Scientist",
"language" : "Hebrew",
"principalName" : "principalName",
"userName" : "userName",
"firstName" : "firstName",
"password" : "password",
"roleIds" : [ "roleIds", "roleIds" ],
"privateProfileId" : "privateProfileId",
"statusID" : "DISABLED",
"phone" : "phone",
"tenantId" : "tenantId",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"proxy2" : "proxy2",
"email" : "email",
"inheritanceType" : "CreateUserOpenIdObject"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AccessServiceApi;
import java.util.*;
public class AccessServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
AccessServiceApi apiInstance = new AccessServiceApi();
// Initialize the createUserOpenId parameter object for the call
CreateUserOpenIdObject createUserOpenId = ; // CreateUserOpenIdObject |
try {
ModifiedItemsResult result = apiInstance.createUserOpenId(createUserOpenId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#createUserOpenId");
e.printStackTrace();
}
}
}
const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
// Configure API key authorization: paToken
const paToken = defaultClient.authentications['paToken'];
paToken.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.apiKeyPrefix['paToken'] = "Token";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
const createUserOpenId = ; // {CreateUserOpenIdObject}
const callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createUserOpenId(createUserOpenId, callback);
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class createUserOpenIdExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AccessServiceApi();
// Initialize the createUserOpenId parameter object for the call
var createUserOpenId = new CreateUserOpenIdObject(); // CreateUserOpenIdObject |
try {
// Adds a new user in the system for OpenID Authentication.
ModifiedItemsResult result = apiInstance.createUserOpenId(createUserOpenId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.createUserOpenId: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# api_config.api_key_prefix['paToken'] = 'Bearer'
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = com.pyramidanalytics.AccessServiceApi(api_client)
# Initialize the createUserOpenId parameter object for the call
createUserOpenId = # CreateUserOpenIdObject |
try:
# Adds a new user in the system for OpenID Authentication.
api_response = api_instance.create_user_open_id(createUserOpenId)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->createUserOpenId: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
$createUserOpenId = ; // CreateUserOpenIdObject |
try {
$result = $api_instance->createUserOpenId($createUserOpenId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->createUserOpenId: ', $e->getMessage(), PHP_EOL;
}
?>
Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.